Non TMF Biz Api

1.0.x
(0 reviews)

POST - productOrdering

CASE 1 Unitary Test

Order creation

URL
https://[localhost]:[port]/nontmf-biz/v1/{businessId}/productOrdering

Base Uri Param

nametypedescriptionrequired
businessIdstringBusiness unit identifier. Example: JM,PA,PR,CRY
namevaluedescriptionrequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
X-Correlation-IDstringIdentifier that correlates HTTP request between a client and server.
Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.		Y
cURL request
{
  "sourceSystem": "Digital",
  "reason": "Digital",
  "digitalOrderId": "12728036637893993",
  "deliveryAddress": {
    "street1": "11237 ",
    "street2": "CALLE JAZMIN",
    "city": "SANTA ISABEL",
    "postalcode": "007573126",
    "state": "PR",
    "country": "US"
  },
  "deliveryType": "Mail Delivery/Direct Delivery",
  "deliverySpeed": "Standard",
  "autopay": true,
  "ebill": true,
  "paymentCaptured": true,
  "transactionId": "24324243242",
  "lineDetails": [
    {
      "lineNumber": "1",
      "planDetails": {
        "msisdn": "2432666644",
        "nokiaReservationId": "234234234",
        "planSku": "2432666644",
        "simType": "Physical SIM/Dynamic SIM",
        "aliasFirstName": "2432666644",
        "aliasLastName": "234234234",
        "portIn": false,
        "portInMsisdn": "",
        "portInCountry": ""
      },
      "deviceDetails": {
        "deviceSku": "106655",
        "installments": true,
        "installmentDetails": {
          "term": "12",
          "frequencyAmount": "55",
          "financedAmount": "550",
          "downpayment": "100",
          "downpaymentTax": "10"
        },
        "quickUpgrade": false,
        "insurance": "1",
        "tradeIn": false,
        "byod": false
      }
    }
  ],
  "accountDetails": {
    "firstName": "2432666644",
    "middleName": "234234234",
    "lastName": "2432666644",
    "email": "asdadsa@gmail.com",
    "phoneNumber": "2432666644",
    "dateOfBirth": "2001-07-26",
    "address": {
      "street1": "11237 ",
      "street2": "CALLE JAZMIN",
      "city": "SANTA ISABEL",
      "postalcode": "007573126",
      "state": "PR",
      "country": "US"
    },
    "consumerPin": "1234",
    "preferredLanguage": "English/Spanish",
    "ssn": "234234234",
    "creditScore": "780",
    "creditSegment": "K",
    "creditScoreDate": "2021-07-26"
  }
}

Definitions

nametypedescriptionrequired
sourceSystemStringName of the source systemY
reasonStringReason of the requestY
digitalOrderIdStringUnique order IDY
deliveryTypeStringType of deliveryN
deliverySpeedStringPriority of DeliveryN
autopayBooleanAuto pay flagN
ebillBooleanEbill flagN
paymentCapturedBooleanPayment flagN
transactionIdStringTransaction IDN
lineDetailsArrayLine DetailsN
lineDetails.lineNumberStringLine identification NumberN
lineDetails.planDetailsObjectDetails of the planN
lineDetails.planDetails.msisdnStringMSISDNN
lineDetails.planDetails.nokiaReservationIdStringReservation ID at NokiaN
lineDetails.planDetails.planSkuStringPlan identifierN
lineDetails.planDetails.simTypeStringType of SimN
lineDetails.planDetails.aliasFirstNameStringFirst name of aliasN
lineDetails.planDetails.aliasLastNameStringLast name of aliasN
lineDetails.planDetails.portInBooleanPort in flagN
lineDetails.planDetails.portInMsisdnStringporting MSISDNN
lineDetails.planDetails.portInCountryStringCountry of port-in request.N
lineDetails.deviceDetailsObjectDetails of the deviceN
lineDetails.deviceDetails.deviceSkuStringdevice SKU identifierN
lineDetails.deviceDetails.installmentsBooleanInstallments flagY
lineDetails.deviceDetails.installmentDetailsObjectDetails of installmentN
lineDetails.deviceDetails.installmentDetails.termStringTerm of installmentN
lineDetails.deviceDetails.installmentDetails.frequencyAmountStringFrequency Amount for the installmentsN
lineDetails.deviceDetails.installmentDetails.financedAmountStringFinanced AmountN
lineDetails.deviceDetails.installmentDetails.downpaymentStringDown paymentN
lineDetails.deviceDetails.installmentDetails.downpaymentTaxStringTax on the down paymentN
lineDetails.deviceDetails.quickUpgradeBooleanUpgrade flagN
lineDetails.deviceDetails.insuranceStringInsurance detailsN
lineDetails.deviceDetails.tradeInBooleanTrade-in flagN
lineDetails.deviceDetails.byodBooleanBYOD flagN
accountDetailsObjectAccount detailsN
accountDetails.firstNameStringFirst Name of accountN
accountDetails.middleNameStringMiddle Name of accountN
accountDetails.lastNameStringLast Name of accountN
accountDetails.emailStringEmail address of accountN
accountDetails.phoneNumberStringPhone Number of accountN
accountDetails.dateOfBirthStringDate of BirthN
accountDetails.addressObjectAddress detailsN
accountDetails.address.street1StringStreet1 addressN
accountDetails.address.street2StringStreet2 addressN
accountDetails.address.cityStringCityN
accountDetails.address.postalcodeStringPostal codeN
accountDetails.address.stateStringStateN
accountDetails.address.countryStringCountryN
accountDetails.consumerPinStringConsumer PINN
accountDetails.preferredLanguageStringPreferred language for communicationN
accountDetails.ssnStringSocial Security NumberN
accountDetails.creditScoreStringCredit ScoreN
accountDetails.creditSegmentStringCredit Segment identifierN
accountDetails.creditScoreDateStringDate of Credit Score fetchedN
deliveryAddressObjectDelivery address detailsN
deliveryAddress.street1StringStreet1 address for deliveryN
deliveryAddress.street2StringStreet2 address for deliveryN
deliveryAddress.cityStringCityN
deliveryAddress.postalcodeStringPostal codeN
deliveryAddress.stateStringStateN
deliveryAddress.countryStringCountryN
Response
Success Response with 200
{
    "status": "Success",
    "message": "Order request received Successfully"
}
nametypedescriptionrequired
statusStringStatus of the requestY
messageStringresponse messageY

Reviews